MarkLogic 10 Product Documentation

GET /manage/v2/users/{id|name}/properties

Summary

This resource address returns the properties of the specified user.

Response

Upon success, MarkLogic Server returns status code 200 (OK), and the response body contains the requested data. A status code of 401 (Unauthorized) is returned if the user does not have the necessary privileges. A status code of 404 (no such user) is returned if the user does not exist.

Required Privileges

• the security and manage-user roles
• the manage role and
  http://marklogic.com/xdmp/privileges/create-data-user and
  http://marklogic.com/xdmp/privileges/user-get-queries to create a user with queries.

Usage Notes

The structure of the output returned from this REST API is as follows:

user-name

User/login name (unique)

description

An object's description.

password

Password.

external-names

The external names specifications.

This is a complex structure with the following children:

external-name

The name used to match external group name.

roles

The roles assigned. The roles assigned to the user.

This is a complex structure with the following children:

role

A role identifier (unique key).

permissions

The default set of permissions used in document creation.

This is a complex structure with the following children:

permission

Permission representation.

This is a complex structure with the following children:

role-name

A role name.

capability

The action/task permitted by a permission

collections

The default set of collections used in document creation.

This is a complex structure with the following children:

collection

The collection uri.

queries

This is a complex structure with the following children:

capability-query

This is a complex structure with the following children:

capability

The action/task permitted by a permission

query

This is a complex structure with the following children:

cts:query

Example

http://localhost:8002/manage/v2/users/joe/properties

==> Returns the properties of the user, "joe," from the Security database.
    

Example

curl -X GET -i --digest -u admin:admin -H "Accept: application/xml" \
http://localhost:8002/manage/v2/users/Vanessa/properties

<user-properties xmlns="http://marklogic.com/manage">
  <user-name>Vanessa</user-name>
  <description>Software development engineer</description>
  <queries>
    <capability-query>
      <capability>read</capability>
      <query>
	<cts:element-query xmlns:cts="http://marklogic.com/cts">
	  <cts:element>metadata</cts:element>
	  <cts:element-word-query>
	    <cts:element>region</cts:element>
	    <cts:text xml:lang="en">NA</cts:text>
	  </cts:element-word-query>
	</cts:element-query>
      </query>
    </capability-query>
  </queries>
</user-properties>

==> Returns the properties of a user, named "Vanessa", with user queries for "read",
from the Security database.